home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 1.6 / Buddy API Docs.swf / texts / 1312.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  3.0 KB  |  121 lines
  1. 68
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. LogIn 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows and Macintosh
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baLogIn displays a log in dialog box.
  20. --- RECORDSEPARATOR ---
  21.  
  22. --- RECORDSEPARATOR ---
  23. Usage:
  24. --- RECORDSEPARATOR ---
  25.  
  26. --- RECORDSEPARATOR ---
  27. Result = baLogIn( Caption, Instruction, UserName, Password, Flags, 
  28. --- RECORDSEPARATOR ---
  29. NameCaption, PasswordCaption, X, Y )
  30. --- RECORDSEPARATOR ---
  31.  
  32. --- RECORDSEPARATOR ---
  33. Arguments:
  34. --- RECORDSEPARATOR ---
  35.  
  36. --- RECORDSEPARATOR ---
  37. String, string, string, string, integer, string, string, integer, integer. 
  38. --- RECORDSEPARATOR ---
  39. Caption is the caption to show in the Title bar. 
  40. --- RECORDSEPARATOR ---
  41. Instruction is the instruction to display to the user. 
  42. --- RECORDSEPARATOR ---
  43. UserName is the text to display in the user name edit box. 
  44. --- RECORDSEPARATOR ---
  45. Password is the text to display in the password edit box. 
  46. --- RECORDSEPARATOR ---
  47. Flags changes the behaviour of the dialog. 
  48. --- RECORDSEPARATOR ---
  49. NameCaption is the text to display beside the user name edit box. 
  50. --- RECORDSEPARATOR ---
  51. PasswordCaption is the text to display beside the password edit box. 
  52. --- RECORDSEPARATOR ---
  53. X is the horizontal position of the dialog. 
  54. --- RECORDSEPARATOR ---
  55. Y is the vertical position of the dialog.
  56. --- RECORDSEPARATOR ---
  57.  
  58. --- RECORDSEPARATOR ---
  59. Returns:
  60. --- RECORDSEPARATOR ---
  61.  
  62. --- RECORDSEPARATOR ---
  63. List. 
  64. --- RECORDSEPARATOR ---
  65. Returns a property list. See notes for details.
  66. --- RECORDSEPARATOR ---
  67.  
  68. --- RECORDSEPARATOR ---
  69. Examples:
  70. --- RECORDSEPARATOR ---
  71.  
  72. --- RECORDSEPARATOR ---
  73. Director: 
  74. --- RECORDSEPARATOR ---
  75. log = baLogIn( "", "Please log in:" , "", "", 2, "User:", "Password:", -1, -1 ) 
  76. --- RECORDSEPARATOR ---
  77. Authorware: 
  78. --- RECORDSEPARATOR ---
  79. log := baLogIn( "", "Please log in:" , "", "", 2, "User:", "Password:", -1, -1 )
  80. --- RECORDSEPARATOR ---
  81.  
  82. --- RECORDSEPARATOR ---
  83. Notes:
  84. --- RECORDSEPARATOR ---
  85.  
  86. --- RECORDSEPARATOR ---
  87. The return will be a property list with 3 entries ΓÇô #name, #password and #Ok. For 
  88. --- RECORDSEPARATOR ---
  89. example; 
  90. --- RECORDSEPARATOR ---
  91. [#Name: "Fred", #Password: "casper", #Ok: 1] 
  92. --- RECORDSEPARATOR ---
  93. If the user cancels, then #Ok will be equal to 0. 
  94. --- RECORDSEPARATOR ---
  95. [#Name: "", #Password: "", #Ok: 0] 
  96. --- RECORDSEPARATOR ---
  97. Five flags are currently defined: 
  98. --- RECORDSEPARATOR ---
  99. 1 
  100. --- RECORDSEPARATOR ---
  101. only allow numbers to be entered 
  102. --- RECORDSEPARATOR ---
  103. 2 
  104. --- RECORDSEPARATOR ---
  105. use ***** to mask the password input 
  106. --- RECORDSEPARATOR ---
  107. 4 
  108. --- RECORDSEPARATOR ---
  109. Don't allow spaces to be entered 
  110. --- RECORDSEPARATOR ---
  111. 8 
  112. --- RECORDSEPARATOR ---
  113. Do not allow blank user name 
  114. --- RECORDSEPARATOR ---
  115. 16 
  116. --- RECORDSEPARATOR ---
  117. Do not allow blank password 
  118. --- RECORDSEPARATOR ---
  119. The values of the X and Y are relative to the screen. Use -1 to center the dialog on 
  120. --- RECORDSEPARATOR ---
  121. the screen, -2 to center on the Director/Authorware window.